Skip to main content
PATCH
Update a line item. id is required in the request body.

Authorizations

Authorization
string
header
required

Bearer authentication. Pass the access token in the Authorization: Bearer <token> header.

Body

application/json

Patch payload for line items.

All fields are optional except id. order_id is intentionally absent — line items cannot be reparented.

id
string<uuid>
required
ad_type
string | null
audience_segments
LineItemAudienceSegment · object | null
bid_strategy
string | null
budget
number | null
Required range: x >= 0
creative_rotation
CreativeRotation · object | null
custom_targeting
CustomTargeting · object | null
daily_budget
number | null
description
string | null
end_date
string<date-time> | null
ext
unknown
goal
string | null
max_bid
number | null
min_daily_imp
number | null
name
string | null
Minimum string length: 1
pace_method
string | null
priority
integer | null
Required range: x >= 0
schedule
LineItemSchedule · object | null
start_date
string<date-time> | null
status
string | null
sub_goal
string | null
target_cpa
number | null
target_cpm
number | null
target_volume
number | null

Response

Successful Response

budget
number
required

Total budget of the line item

created_at
string<date-time>
required
end_date
string<date-time>
required

End date of the line item (UTC)

goal
string
required

Goal of the line item (click, reach, impression, conversion)

id
string<uuid>
required

ID of the line item (uuid7)

name
string
required

Name of the line item

oid
string<uuid>
required

ID of the parent order

owner_id
string<uuid>
required

Owner ID of the line item

start_date
string<date-time>
required

Start date of the line item (UTC)

status
enum<string>
required

Status of the line item (draft, ready, preparing, delivering, archived)

Available options:
draft,
ready,
preparing,
delivering,
archived
target_cpa
number
required

Target cost per acquisition (CPA) for the line item

updated_at
string<date-time>
required
ad_type
string
default:standard

Ad type for the line item (e.g., "standard", "decision")

audience_segments
LineItemAudienceSegment · object | null

Optional audience segments associated with the line item

bid_strategy
string
default:highest_volume

Bid strategy for the line item (default: "highest_volume")

creative_rotation
CreativeRotation · object

Creative rotation strategy for the line item

custom_targeting
CustomTargeting · object | null

Optional custom targeting conditions for the line item

daily_budget
number | null

Optional daily budget of the line item

description
string | null

Optional description of the line item

ext
any | null

Optional extension for the line item

max_bid
number
default:0

Maximum bid amount for the line item (default: 0.0)

min_daily_imp
number
default:1000

Minimum daily impressions for the line item (default: 1000.0)

no
integer | null
pace_method
string
default:evenly

Pacing method for the line item

priority
integer
default:8

Priority of the line item

Required range: x >= 0
schedule
LineItemSchedule · object | null

Optional schedule for the line item

sub_goal
string
default:maximize_volume

Sub-goal of the line item (default: "maximize_volume")

target_cpm
number
default:0

Target cost per thousand impressions (CPM) for the line item (default: 0.0)

target_volume
number
default:0

Target volume for the line item (default: 0.0)